Other Type Definitions
The following type definitions are available globally.
-
A block to processes the result or error of a snapshot request.
Declaration
Objective-C
typedef void (^MGLMapSnapshotCompletionHandler)(MGLMapSnapshot *_Nullable, NSError *_Nullable)
Swift
typealias MGLMapSnapshotCompletionHandler = (MGLMapSnapshot?, Error?) -> Void
Parameters
snapshot
The
MGLMapSnapshot
that was generated ornil
if an error occurred.error
The error that occured or
nil
when successful.
-
A key in the
userInfo
property of a notification posted byMGLOfflinePack
.Declaration
Objective-C
typedef NSString *MGLOfflinePackUserInfoKey
Swift
struct MGLOfflinePackUserInfoKey : RawRepresentable, _SwiftNewtypeWrapper, Equatable, Hashable, _ObjectiveCBridgeable
-
A block to be called once an offline pack has been completely created and added.
An application typically calls the
-resume
method on the pack inside this completion handler to begin the download.Declaration
Objective-C
typedef void (^MGLOfflinePackAdditionCompletionHandler)( MGLOfflinePack *_Nullable, NSError *_Nullable)
Swift
typealias MGLOfflinePackAdditionCompletionHandler = (MGLOfflinePack?, Error?) -> Void
Parameters
pack
Contains a pointer to the newly added pack, or
nil
if there was an error creating or adding the pack.error
Contains a pointer to an error object (if any) indicating why the pack could not be created or added.
-
A block to be called once an offline pack has been completely invalidated and removed.
Avoid any references to the pack inside this completion handler: by the time this completion handler is executed, the pack has become invalid, and any messages passed to it will raise an exception.
Declaration
Objective-C
typedef void (^MGLOfflinePackRemovalCompletionHandler)(NSError *_Nullable)
Swift
typealias MGLOfflinePackRemovalCompletionHandler = (Error?) -> Void
Parameters
error
Contains a pointer to an error object (if any) indicating why the pack could not be invalidated or removed.
-
Options for
MGLShapeSource
objects.Declaration
Objective-C
typedef NSString *MGLShapeSourceOption
Swift
struct MGLShapeSourceOption : RawRepresentable, _SwiftNewtypeWrapper, Equatable, Hashable, _ObjectiveCBridgeable
-
Options for
MGLStyleFunction
objects.Declaration
Objective-C
typedef NSString *MGLStyleFunctionOption
Swift
struct MGLStyleFunctionOption : RawRepresentable, _SwiftNewtypeWrapper, Equatable, Hashable, _ObjectiveCBridgeable
-
Options for
MGLTileSource
objects.Declaration
Objective-C
typedef NSString *MGLTileSourceOption
Swift
struct MGLTileSourceOption : RawRepresentable, _SwiftNewtypeWrapper, Equatable, Hashable, _ObjectiveCBridgeable